﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using System;
using System.Security.Permissions;
using System.Windows.Forms;
using ZO.SmartCore.My4CSharp.Properties;

#endregion

namespace ZO.SmartCore.My4CSharp
{
    /// <summary>Provides properties for getting information about the format and configuration of the mouse installed on the local computer.</summary>
    [HostProtection(SecurityAction.LinkDemand, Resources = HostProtectionResource.ExternalProcessMgmt)]
    public class Mouse
    {

        #region Constructors

        #endregion

        #region Destructor

        #endregion

        #region Fields

        #endregion

        #region Events

        #endregion

        #region Operators

        #endregion

        #region Properties

        /// <summary>Gets a Boolean that indicates if the mouse is installed.</summary>
        /// <returns>A Boolean with value True if the mouse is installed; otherwise False.</returns>
        public bool MousePresent
        {
            get
            {
                return SystemInformation.MousePresent;
            }
        }

        /// <summary>Gets a Boolean that indicates if the mouse has a scroll wheel.</summary>
        /// <returns>A Boolean with value True if the mouse has a scroll wheel; otherwise False.</returns>
        public bool WheelExists
        {
            get
            {
                if (!SystemInformation.MousePresent)
                {
                    throw new InvalidOperationException(Resources.Mouse_NoMouseIsPresent);
                }
                return SystemInformation.MouseWheelPresent;
            }
        }

        /// <summary>Gets a number that indicates how much to scroll when the mouse wheel is rotated one notch.</summary>
        /// <returns>An Integer that indicates how much to scroll when the mouse wheel is rotated one notch. A positive value indicates scrolling by that number of lines, while a negative value indicates scrolling by one screen at a time.</returns>
        /// <filterpriority>1</filterpriority>
        public int WheelScrollLines
        {
            get
            {
                if (!this.WheelExists)
                {
                    throw new InvalidOperationException(Resources.Mouse_NoWheelIsPresent);

                }
                return SystemInformation.MouseWheelScrollLines;
            }
        }
 


        #endregion

        #region Methods

        #endregion
    }
}
